/*! \file cfgdb_internal.h
 *
 * CLI Configuration data manager
 *
 * Configuration data manager definitions intended for internal use only.
 *
 * Application code should normally not need to include this file.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef BCMA_CFGDB_INT_H
#define BCMA_CFGDB_INT_H

#include <sal/sal_internal.h>

#include <bcma/env/bcma_env.h>

/*! Signature for sanity checks. */
#define CFGDB_SIGNATURE   SAL_SIG_DEF('C', 'F', 'G', '>')

/*! Check that this is a valid configuration data manager object. */
#define BAD_CFGDB(_cfgdb)   ((_cfgdb)->cfgdb_sig != CFGDB_SIGNATURE)

/*!
 * \brief Configuration data manager object.
 *
 * All data for the configuration data manager is containe within this object.
 *
 * The signatures in the structure are used for sanity checks.
 */
typedef struct cfgdb_s {

    /*! Signature which indicates that object is initialized. */
    unsigned int cfgdb_sig;

    /*! Environment handle */
    bcma_env_handle_t env;

    /*! File name to load variables from */
    char *fname;

    /*! Temporary file name to write variables to */
    char *tmp_fname;

} cfgdb_t;

/*!
 * \brief Cookie for cfgdb_var_traverse call-back fucntion.
 *
 * Cookie for cfgdb_var_traverse call-back function var_tag_flag_clear
 * and var_tag_flag_set.
 */
struct trvs_tag_flag_op {

    /*! Variable name */
    const char *name;

    /*! Flags value to be clear/set in variable tag */
    int flags;

    /*! Flag to indicate if the flags value has been updated */
    int done;
};

/*!
 * \brief Get Configuration data manager instance.
 *
 * \retval Pointer to configuration data manager instance.
 */
extern cfgdb_t *
bcma_cfgdb_get(void);

/*!
 * \brief Wildcard string match.
 *
 * For internal use only.
 *
 * Function for comparing wildcard string 'wc_str' with wildcard character '*'
 * and target string 'str'.
 * Return value is TRUE if string 'str' matches the wildcard string 'wc_str'.
 * Otherwise return value is FALSE.
 * For example:
 * If wildcard string is "*mem*", it would match "memory" or "socmem".
 * If wildcard string is "mem*", it would only match "memory".
 * If wild card string is "*mem", it would only match "socmem".
 *
 * \param[in] str Target string to be compared
 * \param[in] wc_str String with wildcard character '*' to compare
 *
 * \retval TRUE Strings are matching
 * \retval FALSE Strings don't match
 */
extern int
bcma_cfgdb_wildcard_match(const char *str, const char *wc_str);

/*!
 * \brief Call-back function of bcma_cfgdb_var_traverse.
 *
 * For internal use only.
 *
 * Call-back function of cfgdb_var_traverse to clear flags in variable tag.
 * Pointer of struct trvs_tag_flag_op is the cookie of the call-back function.
 * If name in cookie is NULL, all variables flags will be cleared by mask off
 * flags in cookie. Otherwise only flag of variable name matches the name in
 * cookie will be update.
 *
 * \param[in] cookie Cookie for traverse function
 * \param[in] name Variable name
 * \param[in] value Variable value
 * \param[in] tag Variable tag pointer
 * \param[in] hash_idx Hash bucket of variable list (-1 if hash table is not activated)
 *
 * \retval 0 Continue traversing
 * \retval BCMA_CFGDB_VAR_TRAVERSE_STOP Stop traversing
 */
extern int
bcma_cfgdb_var_tag_flags_clear(void *cookie, const char *name,
                               const char *value,
                               uint32_t *tag, int hash_idx);

/*!
 * \brief Call-back function of bcma_cfgdb_var_traverse.
 *
 * For internal use only.
 *
 * Call-back function of cfgdb_var_traverse to set flags in variable tag.
 * Pointer of struct trvs_tag_flag_op is the cookie of the call-back function.
 * If name in cookie is NULL, all variables flags will be set by ORed with
 * flags in cookie. Otherwise only flag of variable name matches the name in
 * cookie will be set.
 *
 * \param[in] cookie Cookie for traverse function
 * \param[in] name Variable name
 * \param[in] value Variable value
 * \param[in] tag Variable tag pointer
 * \param[in] hash_idx Hash bucket of variable list (-1 if hash table is not activated)
 *
 * \retval 0 Continue traversing
 * \retval BCMA_CFGDB_VAR_TRAVERSE_STOP Stop traversing
 */
extern int
bcma_cfgdb_var_tag_flags_set(void *cookie, const char *name, const char *value,
                             uint32_t *tag, int hash_idx);

#endif /* BCMA_CFGDB_INT_H */
